com.inscoper.nbo.Shutter

Represents the XML element Shutter. More...

Inherits from com.inscoper.nbo.OpticalAperture_Type, com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	Shutter()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setResponseTime(float value) Sets the value of the ResponseTime attribute.
float	getResponseTime() Returns the value of the ResponseTime attribute.
void	resetResponseTime() Resets the ResponseTime attribute to an unset state.
boolean	hasResponseTime() Checks whether the optional ResponseTime attribute is present.
void	setResponseTimeUnit(UnitsTime_Type value) Sets the value of the ResponseTimeUnit attribute.
UnitsTime_Type	getResponseTimeUnit() Returns the value of the ResponseTimeUnit attribute.
void	resetResponseTimeUnit() Resets the ResponseTimeUnit attribute to an unset state.
boolean	hasResponseTimeUnit() Checks whether the optional ResponseTimeUnit attribute is present.
void	setFunction(ShutterFunction_Type value) Sets the value of the Function attribute.
ShutterFunction_Type	getFunction() Returns the value of the Function attribute.
void	resetFunction() Resets the Function attribute to an unset state.
boolean	hasFunction() Checks whether the optional Function attribute is present.
void	setOperatingFrequency(float value) Sets the value of the OperatingFrequency attribute.
float	getOperatingFrequency() Returns the value of the OperatingFrequency attribute.
void	resetOperatingFrequency() Resets the OperatingFrequency attribute to an unset state.
boolean	hasOperatingFrequency() Checks whether the optional OperatingFrequency attribute is present.
void	setOperatingFrequencyUnit(UnitsFrequency_Type value) Sets the value of the OperatingFrequencyUnit attribute.
UnitsFrequency_Type	getOperatingFrequencyUnit() Returns the value of the OperatingFrequencyUnit attribute.
void	resetOperatingFrequencyUnit() Resets the OperatingFrequencyUnit attribute to an unset state.
boolean	hasOperatingFrequencyUnit() Checks whether the optional OperatingFrequencyUnit attribute is present.
void	setMotorized(boolean value) Sets the value of the Motorized attribute.
boolean	getMotorized() Returns the value of the Motorized attribute.
void	resetMotorized() Resets the Motorized attribute to an unset state.
boolean	hasMotorized() Checks whether the optional Motorized attribute is present.
void	setMaxApertureDiameter(float value) Sets the value of the MaxApertureDiameter attribute.
float	getMaxApertureDiameter() Returns the value of the MaxApertureDiameter attribute.
void	resetMaxApertureDiameter() Resets the MaxApertureDiameter attribute to an unset state.
boolean	hasMaxApertureDiameter() Checks whether the optional MaxApertureDiameter attribute is present.
void	setMaxApertureDiameterUnit(UnitsLength_Type value) Sets the value of the MaxApertureDiameterUnit attribute.
UnitsLength_Type	getMaxApertureDiameterUnit() Returns the value of the MaxApertureDiameterUnit attribute.
void	resetMaxApertureDiameterUnit() Resets the MaxApertureDiameterUnit attribute to an unset state.
boolean	hasMaxApertureDiameterUnit() Checks whether the optional MaxApertureDiameterUnit attribute is present.
void	setMultimode(boolean value) Sets the value of the Multimode attribute.
boolean	getMultimode() Returns the value of the Multimode attribute.
void	resetMultimode() Resets the Multimode attribute to an unset state.
boolean	hasMultimode() Checks whether the optional Multimode attribute is present.
Shutter	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	Shutter(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Shutter obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.OpticalAperture_Type

	Name
	OpticalAperture_Type()
void	setID(LensID_Type value) Sets the value of the ID attribute.
LensID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setOpticsHolderPosition(String value) Sets the value of the OpticsHolderPosition attribute.
String	getOpticsHolderPosition() Returns the value of the OpticsHolderPosition attribute.
void	resetOpticsHolderPosition() Resets the OpticsHolderPosition attribute to an unset state.
boolean	hasOpticsHolderPosition() Checks whether the optional OpticsHolderPosition attribute is present.
void	setOuterDiameter(float value) Sets the value of the OuterDiameter attribute.
float	getOuterDiameter() Returns the value of the OuterDiameter attribute.
void	resetOuterDiameter() Resets the OuterDiameter attribute to an unset state.
boolean	hasOuterDiameter() Checks whether the optional OuterDiameter attribute is present.
void	setOuterDiameterUnit(UnitsLength_Type value) Sets the value of the OuterDiameterUnit attribute.
UnitsLength_Type	getOuterDiameterUnit() Returns the value of the OuterDiameterUnit attribute.
void	resetOuterDiameterUnit() Resets the OuterDiameterUnit attribute to an unset state.
boolean	hasOuterDiameterUnit() Checks whether the optional OuterDiameterUnit attribute is present.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.

Protected Functions inherited from com.inscoper.nbo.OpticalAperture_Type

	Name
	OpticalAperture_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the optional LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.Shutter;

Represents the XML element Shutter.

This element describes a Shutter available for this Instrument. Shutters are devices that open and close, and they may be mechanically or electro-mechanically controlled. Shutters are typically used to control the Light that raches the sample (i.e., to limit phototoxicity and photobleaching especially in case of live specimens), or the Detecrtor at any one time. They can also be used for Excitation or Emission Wavelength selection.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.OpticalAperture_Type.delete

function Shutter

public Shutter()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.OpticalAperture_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.OpticalAperture_Type.toXmlFile

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.OpticalAperture_Type.toXmlString

function setResponseTime

public void setResponseTime(
    float value
)

Sets the value of the ResponseTime attribute.

Parameters:

value The value to set

This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.

function getResponseTime

public float getResponseTime()

Returns the value of the ResponseTime attribute.

Return: The value of the attribute

This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.

function resetResponseTime

public void resetResponseTime()

Resets the ResponseTime attribute to an unset state.

This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.

function hasResponseTime

public boolean hasResponseTime()

Checks whether the optional ResponseTime attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field (also known as Speed) records the time it takes for this Shutter to completely open and close, according to the Manufacturer.

function setResponseTimeUnit

public void setResponseTimeUnit(
    UnitsTime_Type value
)

Sets the value of the ResponseTimeUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getResponseTimeUnit

public UnitsTime_Type getResponseTimeUnit()

Returns the value of the ResponseTimeUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetResponseTimeUnit

public void resetResponseTimeUnit()

Resets the ResponseTimeUnit attribute to an unset state.

No description available in the XSD standard.

function hasResponseTimeUnit

public boolean hasResponseTimeUnit()

Checks whether the optional ResponseTimeUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setFunction

public void setFunction(
    ShutterFunction_Type value
)

Sets the value of the Function attribute.

Parameters:

value The value to set

This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.

function getFunction

public ShutterFunction_Type getFunction()

Returns the value of the Function attribute.

Return: The value of the attribute

This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.

function resetFunction

public void resetFunction()

Resets the Function attribute to an unset state.

This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.

function hasFunction

public boolean hasFunction()

Checks whether the optional Function attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records whether this Shutter is used for the control of illumination (especially relevant for live imaging), the selection of Excitation or Emission wavelenghts or the control of the Light that reaches the Detector.

function setOperatingFrequency

public void setOperatingFrequency(
    float value
)

Sets the value of the OperatingFrequency attribute.

Parameters:

value The value to set

This field records the Frequency of Operation of this Shutter, according to the Manufactuers.

function getOperatingFrequency

public float getOperatingFrequency()

Returns the value of the OperatingFrequency attribute.

Return: The value of the attribute

This field records the Frequency of Operation of this Shutter, according to the Manufactuers.

function resetOperatingFrequency

public void resetOperatingFrequency()

Resets the OperatingFrequency attribute to an unset state.

This field records the Frequency of Operation of this Shutter, according to the Manufactuers.

function hasOperatingFrequency

public boolean hasOperatingFrequency()

Checks whether the optional OperatingFrequency attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the Frequency of Operation of this Shutter, according to the Manufactuers.

function setOperatingFrequencyUnit

public void setOperatingFrequencyUnit(
    UnitsFrequency_Type value
)

Sets the value of the OperatingFrequencyUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getOperatingFrequencyUnit

public UnitsFrequency_Type getOperatingFrequencyUnit()

Returns the value of the OperatingFrequencyUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetOperatingFrequencyUnit

public void resetOperatingFrequencyUnit()

Resets the OperatingFrequencyUnit attribute to an unset state.

No description available in the XSD standard.

function hasOperatingFrequencyUnit

public boolean hasOperatingFrequencyUnit()

Checks whether the optional OperatingFrequencyUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMotorized

public void setMotorized(
    boolean value
)

Sets the value of the Motorized attribute.

Parameters:

value The value to set

This field describes whether this device is Motor (True) or Manually (False) operated.

function getMotorized

public boolean getMotorized()

Returns the value of the Motorized attribute.

Return: The value of the attribute

This field describes whether this device is Motor (True) or Manually (False) operated.

function resetMotorized

public void resetMotorized()

Resets the Motorized attribute to an unset state.

This field describes whether this device is Motor (True) or Manually (False) operated.

function hasMotorized

public boolean hasMotorized()

Checks whether the optional Motorized attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field describes whether this device is Motor (True) or Manually (False) operated.

function setMaxApertureDiameter

public void setMaxApertureDiameter(
    float value
)

Sets the value of the MaxApertureDiameter attribute.

Parameters:

value The value to set

This field records the Maximum physical Diameter of the Aperture of this Shutter.

function getMaxApertureDiameter

public float getMaxApertureDiameter()

Returns the value of the MaxApertureDiameter attribute.

Return: The value of the attribute

This field records the Maximum physical Diameter of the Aperture of this Shutter.

function resetMaxApertureDiameter

public void resetMaxApertureDiameter()

Resets the MaxApertureDiameter attribute to an unset state.

This field records the Maximum physical Diameter of the Aperture of this Shutter.

function hasMaxApertureDiameter

public boolean hasMaxApertureDiameter()

Checks whether the optional MaxApertureDiameter attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the Maximum physical Diameter of the Aperture of this Shutter.

function setMaxApertureDiameterUnit

public void setMaxApertureDiameterUnit(
    UnitsLength_Type value
)

Sets the value of the MaxApertureDiameterUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getMaxApertureDiameterUnit

public UnitsLength_Type getMaxApertureDiameterUnit()

Returns the value of the MaxApertureDiameterUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMaxApertureDiameterUnit

public void resetMaxApertureDiameterUnit()

Resets the MaxApertureDiameterUnit attribute to an unset state.

No description available in the XSD standard.

function hasMaxApertureDiameterUnit

public boolean hasMaxApertureDiameterUnit()

Checks whether the optional MaxApertureDiameterUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMultimode

public void setMultimode(
    boolean value
)

Sets the value of the Multimode attribute.

Parameters:

value The value to set

This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).

function getMultimode

public boolean getMultimode()

Returns the value of the Multimode attribute.

Return: The value of the attribute

This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).

function resetMultimode

public void resetMultimode()

Resets the Multimode attribute to an unset state.

This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).

function hasMultimode

public boolean hasMultimode()

Checks whether the optional Multimode attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records whether (True) multiple operation modes are available for this Shutter or not (False). Typical operation modes are are: Fast, Soft and Neutral Density. The Fast mode provides the quickest open and close action sequence for which the shutter is capable. The Soft mode gradually opens and closes the shutter to reduce vibration. Control of light intensity without affecting wavelength is accommodated by a Neutral Density shutter mode (for more details see https://www.microscopyu.com/applications/live-cell-imaging/the-automatic-microscope).

function __internal_create

public static Shutter __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAperture_Type.__internal_create

Protected Functions Documentation

function Shutter

protected Shutter(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAperture_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.OpticalAperture_Type.finalize

function getCPtr

protected static long getCPtr(
    Shutter obj
)

Updated on 2026-02-13 at 16:11:06 +0100